

package com.hazelcast.internal.metrics;

/**
 * A DoubleGauge is a {@link Gauge} where a particular double value is read
 * instantaneously. E.g. the current OS load.
 * <p>
 * {@link LongGauge}
 */
public interface DoubleGauge extends Gauge {

    /**
     * Reads the current available value as a double.
     * <p>
     * If the underlying probe provides a long value, then the value will
     * be converted to a floating point value.
     * <p>
     * If no probe is available, or there are problems obtaining a value
     * from the probe, 0 is returned.
     *
     * @return the current value.
     */
    double read();
}
